Description | Example | Return Message | Group(s)

SCHED: GetScheduleComparisonReportJson

Format

SCHED / GetScheduleComparisonReportJson '<SchedulePath>' '<ReportPath>'

Description

The SCHED GetScheduleComparisonReportJson Connect command returns a report that compares the specified schedule with the current schedule in JSON format.

GetScheduleComparisonReportJson vs. GetScheduleComparisonReport

The choice of command will depend on use case.

SCHED GetScheduleComparisonReportJson provides output in a commonly used format that is easy to parse. This command is preferred if schedule comparison information will be further processed.

SCHED GetScheduleComparisonReport provides output that is difficult to parse but easy to understand. This command is preferred if no further processing is required.

Parameters

  • SchedulePath: This parameter is a string of text in single quotes of the absolute file path of a schedule, which will be compared to the currently-selected schedule.
  • FileName: The parameter is a string of text in single quotes of the absolute path file name, to which the report will be saved. Empty strings are allowed; the report will not be saved.

Examples

Generates a report listing the differences between the currently-active schedule and the schedule saved as "ScheduleComparisonB.ssc"
SCHED / GetScheduleComparisonReportJson 'C:\Schedules\ScheduleComparisonB.ssc' 'C:\Outputs\ScheduleComparisonReport.json'

SyntaxExample
<CommandName>SCHED / GetScheduleComparisonReportJson
<SchedulePath>'C:\Schedules\ScheduleComparisonB.ssc'
<FileName>'C:\Outputs\ScheduleComparisonReport.json'

Return Message

Connect returns a message that contains all of the schedule comparison report data in JSON format. See Schedule Comparison Report Details for more information.

The following JSON file contains sample output of the above command.

Group Membership

This command belongs to the following group(s):

Scheduler

Version

12.0